@double-great/alt-text
Advanced tools
Check for unhelpful alt text.
Alt text describes an image. This description provides context for people with low or no vision. The text is a fallback for users with images turned off or when an image fails to load.
The usefulness of alt text can be subjective. Context, detail, length, and relevance contribute to the quality of the description. Determining alt text quality is a manual effort, but there are patterns to avoid.
altText checks for common issues found in alt text and suggests improvements.
Are you writing in markdown? We recommend using remark-lint-alt-text.
npm install @double-great/alt-text
If altText detects an issue, it will return a warning to help you fix it. If altText doesn't detect any issues it will return undefined.
const altText = require("@double-great/alt-text");
console.log(altText("A child holding a photograph."));
// undefined
console.log(altText("A screenshot of a dog"));
// Alt text should not contain "screenshot of". Alt text should end in a period.
Warning: Alt text should not contain "graphic of, image of, photo of, photo:, photograph of, photographer:, picture of, screenshot of"
Screen readers announce the presence of an image before reading the alt text. Adding “picture of” or “photo of” is redundant in this context.
Sources:
Warning: Alt text should not be "*, alt, arrow, artwork, blank, bullet, button, chart, diagram, drawing, empty, graph, graphic, icon, image, logo, more, painting, photo, photograph, placeholder, spacer, table, temp"
Usually, there’s no need to include words like “image”, “icon”, or “picture” in the alt text. People who can see will know this already, and screen readers announce the presence of an image.
Sources:
Warning: Alt text should not end with ".gif, .jpeg, .jpg, .png, .svg, .webp, graphic, image"
A file name in alt text does not provide helpful context.
Sources:
Warning: Alt text should not start with "graphic, image, photo, photograph, photographer, picture, screenshot, spacer"
Usually, there’s no need to include words like “image”, “icon”, or “picture” in the alt text. People who can see will know this already, and screen readers announce the presence of an image.
Sources:
Warning: Alt text length should be less than 125 characters
Alt text should be less than 125 characters in length. The JAWS screen reader reads alt text in 125 character chunks. Any information about the image, such as copyright information, image source or extra information should be placed in the caption text below the image.
Sources:
Warning: Alt text should not be a single space
If you use null (empty) alt text (alt="") to hide decorative images, make sure that there is no space character in between the quotes. If a space character is present, the image may not be effectively hidden from assistive technologies. For instance, some screen readers will still announce the presence of an image if a space character is put between the quotes.
<img src="photo.png" alt=""><img src="photo.png" alt=" ">Sources:
Warning: Alt text should end in a period
End the alt text with a period. This will make screen readers pause a bit after the last word in the alt text, which creates a more pleasant reading experience for the user.
Sources:
Warning: Empty alt text should only be used for decorative images
Provide "null" alt attributes (using alt="") for images which do not provide information or do not require alternative text because the image is described in the page content. Some developers will mistakenly leave off the alt attribute altogether on images which they deem do not need alternatives. This is not helpful to assistive technology users because the assistive technology, such as screen reader, will often read the source attribute (i.e., file name) as the alternative text. To tell assistive technology to ignore an image, use a "blank alternative text" attribute: alt="".
<img src="decorative-photo.jpg" alt=""><img src="quarterly-earnings-chart.png" alt=""/>Sources:
Warning: Images inside a link tag require alt text that describes the purpose of the link
Images inside a link tag require alt text that describes the purpose of the link.
<a href="https://github.com/double-great"><img src="logo.png" alt="double great on GitHub"></a><a href="https://github.com/double-great"><img src="logo.png" alt="double great logo"></a>Sources:
Warning: Missing "alt" attribute
All images must have alternate text to convey their purpose and meaning to screen reader users.
<img src="photograph.jpg" alt="A child holding a photograph."><img src="photograph.jpg">Sources:
FAQs
Check for unhelpful alt text.
We found that @double-great/alt-text demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.